﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

#pragma once

#include "GcmpModelInterface.h"
#include "IDbObject.h"
#include "RegenDataId.h"

namespace gcmp {

    class IGraphicsElementShape;
    class IBaseGraphicsElementShapeValidiator;
    class IElement;
    
    /// \brief 基础图形表达组件接口
  FINAL_INTERFACE class GCMP_MODEL_INTERFACE_EXPORT IBaseGraphicsElementShapeComponent : public IDbObject
    {
        DEFINE_CAST_DERIVED(gcmp::IBaseGraphicsElementShapeComponent, gcmp::IDbObject);

    public:
        /// \brief 获取基础图形表达数据。
        ///
        /// 基础图形表达数据由Symbol显示数据经过实例的变换而生成。
        /// \return 返回基础图形表达指针。
        virtual const IGraphicsElementShape* GetBaseGraphicsElementShape() const = 0;

        /// \brief 设置基础图形表达数据。
        /// 设置后会触发关联更新
        /// \param pGraphicsElementShape 新的基础图形表达数据指针。
        /// \return bool
        virtual bool SetBaseGraphicsElementShape(OwnerPtr<IGraphicsElementShape> pGraphicsElementShape) = 0;

        /// \brief 获得Element图形表达关联更新变化Id
        /// \return lement图形表达关联更新变化Id
        virtual RegenDataId GetBaseGraphicsElementShapeRdId() const = 0;

        /// \brief 设置当前图形表达验证验证器
        /// 
        /// 若已存在图形表达验证器，则覆盖
        /// 
        /// \param pValidator 图形表达验证器
        /// \return true 设置成功， false 设置失败
        virtual bool SetValidator(OwnerPtr<IBaseGraphicsElementShapeValidiator> pValidator) = 0;

        /// \brief 获取当前图形表达的验证器
        ///
        /// \return IBaseGraphicsElementShapeValidiator* 当前图形表达的验证器，若当前图形表达没有验证器，则返回为nullptr
        virtual const IBaseGraphicsElementShapeValidiator* GetValidator() const = 0;

    public:
        /// \brief 设置该行为所属Element
        /// \param pOwnerElement 所属Element
        /// \return bool
        virtual bool SetOwnerElement(IElement* pOwnerElement) = 0;

        /// \brief 获得该行为所属的Element
        /// \return 所属的Element
        virtual IElement* GetOwnerElement() = 0;

        /// \brief 获得该行为所属的Element
        /// \return 所属的Element
        virtual const IElement* GetOwnerElement() const = 0;
    };
}// namespace gcmp


